MainFeed

Interfaces

MainFeedProps

Properties

FeedObjectProps?

optional FeedObjectProps: FeedObjectProps

Props to spread to single feed object

Default

empty object

Source

MainFeed/MainFeed.tsx:60

FeedProps?

optional FeedProps: Omit<FeedProps, "endpoint" | "ItemComponent" | "widgets" | "itemPropsGenerator" | "itemIdGenerator" | "ItemSkeleton" | "ItemSkeletonProps" | "FeedSidebarProps">

Props to spread to feed component

Default

{}

Source

MainFeed/MainFeed.tsx:72

FeedSidebarProps?

optional FeedSidebarProps: StickyBoxProps

Props to spread to single feed object

Default

{top: 0, bottomBoundary: `#${id}`}

Source

MainFeed/MainFeed.tsx:66

className?

optional className: string

Overrides or extends the styles applied to the component.

Default

null

Source

MainFeed/MainFeed.tsx:48

id?

optional id: string

Id of the feed object

Default

'feed'

Source

MainFeed/MainFeed.tsx:42

widgets?

optional widgets: SCFeedWidgetType[]

Widgets to be rendered into the feed

Default

[CategoriesFollowed, UserFollowed]

Source

MainFeed/MainFeed.tsx:54

Functions

MainFeed()

MainFeed(inProps): JSX.Element

API documentation for the Community-JS Main Feed Template. Learn about the available props and the CSS API.

This component renders the template for the main feed. Take a look at our demo component here

Import

import {MainFeed} from '@selfcommunity/react-templates';

Component Name

The name SCMainFeedTemplate can be used when providing style overrides in the theme.

CSS

Rule Name	Global class	Description
root	.SCMainFeedTemplate-root	Styles applied to the root element.

Parameters

Parameter	Type	Description
inProps	MainFeedProps

Returns

JSX.Element

Source

MainFeed/MainFeed.tsx:135

---

MainFeedSkeleton()

MainFeedSkeleton(): JSX.Element

API documentation for the Community-JS Main Feed Skeleton Template. Learn about the available props and the CSS API.

Import

import {MainFeedSkeleton} from '@selfcommunity/react-templates';

Component Name

The name SCMainFeedTemplate-skeleton-root can be used when providing style overrides in the theme.

CSS

Rule Name	Global class	Description
root	.SCMainFeedTemplate-skeleton-root	Styles applied to the root element.

Returns

JSX.Element

Source

MainFeed/Skeleton.tsx:35